package com.behelpful.common.core.jackson.sensitive;

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义字段系列化注解
 * JacksonAnnotationsInside 标记为捆绑系列化注解
 *
 * @author Alay
 * @date 2021-09-10 10:17
 * @see {参考博客：https://blog.csdn.net/liufei198613/article/details/79009015,以及开源pig项目}
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = StringSensitiveSerializer.class)
public @interface Sensitive {


    /**
     * 脱敏数据类型, 非Customer时, 将忽略 maskEndAt 和 maskEndAt 和 maskStr
     */
    SensitiveTypeEnum type() default SensitiveTypeEnum.CUSTOMER;

    /**
     * 打码起始长度
     */
    int maskStartLen() default 0;

    /**
     * 打码结束保留长度
     */
    int keepTailLen() default 0;

    /**
     * 用什么打码
     */
    String maskStr() default "*";

}
